<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>openttd.date.OpenTTDDate</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://openttd-python.googlecode.com">OpenTTD-Python</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="openttd-module.html">Package&nbsp;openttd</a> ::
        <a href="openttd.date-module.html">Module&nbsp;date</a> ::
        Class&nbsp;OpenTTDDate
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="openttd.date.OpenTTDDate-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class OpenTTDDate</h1><p class="nomargin-top"><span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">OpenTTDDate</strong>
</pre>

<hr />
<p>Class that allows conversion between openttd dates and python 
  dates</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="openttd.date.OpenTTDDate-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">ottddate</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">pydate</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">year</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">month</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">day</span>=<span class="summary-sig-default">None</span>)</span><br />
      constructor for OpenTTDDate</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="openttd.date.OpenTTDDate-class.html#fromYMD" class="summary-sig-name">fromYMD</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">year</span>,
        <span class="summary-sig-arg">month</span>,
        <span class="summary-sig-arg">day</span>)</span><br />
      convert from YMD</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.fromYMD">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="openttd.date.OpenTTDDate-class.html#fromDate" class="summary-sig-name">fromDate</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">date</span>)</span><br />
      convert from datetime.date</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.fromDate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="openttd.date.OpenTTDDate-class.html#fromOpenTTDDate" class="summary-sig-name">fromOpenTTDDate</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">date</span>)</span><br />
      convert from openttd date</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.fromOpenTTDDate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">tuple</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="openttd.date.OpenTTDDate-class.html#toYMD" class="summary-sig-name">toYMD</a>(<span class="summary-sig-arg">self</span>)</span><br />
      convert to YMD</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.toYMD">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">datetime.date instance</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="openttd.date.OpenTTDDate-class.html#toDate" class="summary-sig-name">toDate</a>(<span class="summary-sig-arg">self</span>)</span><br />
      convert to datetime.date</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.toDate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">int</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="openttd.date.OpenTTDDate-class.html#toOpenTTDDate" class="summary-sig-name">toOpenTTDDate</a>(<span class="summary-sig-arg">self</span>)</span><br />
      convert to openttd date</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.toOpenTTDDate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">datetime.date instance</span>
    </td><td class="summary">
        <a name="_date"></a><span class="summary-name">_date</span><br />
      date
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">ottddate</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">pydate</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">year</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">month</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">day</span>=<span class="sig-default">None</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>constructor for OpenTTDDate</p>
  <p>example:</p>
  <ul>
    <li>
      OpenTTDDate(ottddate=302974).toYMD()
    </li>
    <li>
      OpenTTDDate(year=2008, month=10, day=12).toOpenTTDDate()
    </li>
  </ul>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ottddate</code></strong> (int) - openttd date to convert from</li>
        <li><strong class="pname"><code>pydate</code></strong> (datetime.date instance) - datetime.date to convert from</li>
        <li><strong class="pname"><code>year</code></strong> (int) - year to convert from</li>
        <li><strong class="pname"><code>month</code></strong> (int) - month to convert from</li>
        <li><strong class="pname"><code>day</code></strong> (int) - day to convert from</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="fromYMD"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">fromYMD</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">year</span>,
        <span class="sig-arg">month</span>,
        <span class="sig-arg">day</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.fromYMD">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>convert from YMD</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>year</code></strong> (int) - year to convert from</li>
        <li><strong class="pname"><code>month</code></strong> (int) - month to convert from</li>
        <li><strong class="pname"><code>day</code></strong> (int) - day to convert from</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="fromDate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">fromDate</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">date</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.fromDate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>convert from datetime.date</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>date</code></strong> (datetime.date instance) - date to convert from</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="fromOpenTTDDate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">fromOpenTTDDate</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">date</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.fromOpenTTDDate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>convert from openttd date</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>date</code></strong> (int) - date to convert from</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="toYMD"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">toYMD</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.toYMD">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>convert to YMD</p>
  <dl class="fields">
    <dt>Returns: tuple</dt>
        <dd>(year, month, day)</dd>
  </dl>
</td></tr></table>
</div>
<a name="toDate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">toDate</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.toDate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>convert to datetime.date</p>
  <dl class="fields">
    <dt>Returns: datetime.date instance</dt>
        <dd>converted date</dd>
  </dl>
</td></tr></table>
</div>
<a name="toOpenTTDDate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">toOpenTTDDate</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="openttd.date-pysrc.html#OpenTTDDate.toOpenTTDDate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>convert to openttd date</p>
  <dl class="fields">
    <dt>Returns: int</dt>
        <dd>openttd date</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://openttd-python.googlecode.com">OpenTTD-Python</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Oct 20 13:03:11 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
